/*
 * Concurrency.java    ver   19/nov/2009
 *
 * Copyright (c) 2009 mentalsmash.org
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * The use of the Apache License does not indicate that this project is
 * affiliated with the Apache Software Foundation.
 */
package org.mentalsmash.documentation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * The <tt>Concurrency</tt> annotation is a documentation annotation, used to
 * specify what are the possible problems and solutions due to possible
 * concurrent access to the type this annotation is applied to.
 * <p>
 * the <code>concurrentAccess</code> is a boolean property used to tell wheter
 * an instance of the type can possibly have concurrent accesses or not.
 * </p>
 * <p>
 * the <code>specification</code> property is a String property, that should
 * contain a detail description of what are the concurrency related problems of
 * the annotated type, and which are the solutions taken to avoid that problems.
 * The specification property is expressed in natural language.
 * </p>
 * <p>
 * Since the purpose of this annotation is source documentation only, the
 * annotation is discarded at compilation time, having
 * {@link RetentionPolicy#SOURCE}.
 * </p>
 * 
 * @version 0.0.1 19/nov/2009
 * @author Andrea Reale <andrea.reale@gmail.com>
 * 
 */
@Retention(RetentionPolicy.SOURCE)
@Target(ElementType.TYPE)
public @interface Concurrency {
    boolean concurrentAccess();

    String specification();
}
